<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>esapi.codecs.codec</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="esapi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="esapi-module.html">Package&nbsp;esapi</a> ::
        <a href="esapi.codecs-module.html">Package&nbsp;codecs</a> ::
        Module&nbsp;codec
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="esapi.codecs.codec-pysrc.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="esapi.codecs.codec-module.html">Module esapi.codecs.codec</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-comment">#!/usr/bin/python</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-comment"># -*- coding: utf-8 -*-</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-docstring">@license: OWASP Enterprise Security API (ESAPI)</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-docstring">     </tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-docstring">    This file is part of the Open Web Application Security Project (OWASP)</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-docstring">    Enterprise Security API (ESAPI) project. For details, please see</tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-docstring">    U{http://www.owasp.org/index.php/ESAPI&lt;http://www.owasp.org/index.php/ESAPI&gt;}.</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-docstring">    The ESAPI is published by OWASP under the BSD license. You should read and </tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-docstring">    accept the LICENSE before you use, modify, and/or redistribute this software.</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-docstring">    </tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-docstring">@summary: The Codec interface defines a set of methods for encoding and </tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-docstring">    decoding application level encoding schemes.</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-docstring">@copyright: Copyright (c) 2009 - The OWASP Foundation</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-docstring">@author: Craig Younkins (craig.younkins@owasp.org)</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-docstring">"""</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Package esapi=esapi-module.html"><a title="esapi" class="py-name" href="#" onclick="return doclink('link-0', 'esapi', 'link-0');">esapi</a></tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Package esapi.codecs=esapi.codecs-module.html"><a title="esapi.codecs" class="py-name" href="#" onclick="return doclink('link-1', 'codecs', 'link-1');">codecs</a></tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Module esapi.codecs.push_back_string=esapi.codecs.push_back_string-module.html"><a title="esapi.codecs.push_back_string" class="py-name" href="#" onclick="return doclink('link-2', 'push_back_string', 'link-2');">push_back_string</a></tt> <tt class="py-keyword">import</tt> <tt id="link-3" class="py-name" targets="Class esapi.codecs.push_back_string.PushbackString=esapi.codecs.push_back_string.PushbackString-class.html"><a title="esapi.codecs.push_back_string.PushbackString" class="py-name" href="#" onclick="return doclink('link-3', 'PushbackString', 'link-3');">PushbackString</a></tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line">       </tt>
<a name="is_8bit"></a><div id="is_8bit-def"><a name="L22"></a><tt class="py-lineno"> 22</tt> <a class="py-toggle" href="#" id="is_8bit-toggle" onclick="return toggle('is_8bit');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.codec-module.html#is_8bit">is_8bit</a><tt class="py-op">(</tt><tt class="py-param">char</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="is_8bit-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="is_8bit-expanded"><a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-docstring">    Returns True if ord(char) &lt; 256, False otherwise</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">ord</tt><tt class="py-op">(</tt><tt class="py-name">char</tt><tt class="py-op">)</tt> <tt class="py-op">&lt;</tt> <tt class="py-number">256</tt> </tt>
</div><a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line">         </tt>
<a name="is_control_char"></a><div id="is_control_char-def"><a name="L28"></a><tt class="py-lineno"> 28</tt> <a class="py-toggle" href="#" id="is_control_char-toggle" onclick="return toggle('is_control_char');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.codec-module.html#is_control_char">is_control_char</a><tt class="py-op">(</tt><tt class="py-param">char</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="is_control_char-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="is_control_char-expanded"><a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line">    <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">ord</tt><tt class="py-op">(</tt><tt class="py-name">char</tt><tt class="py-op">)</tt> <tt class="py-op">&lt;=</tt> <tt class="py-number">0x1F</tt> <tt class="py-keyword">or</tt>        <tt class="py-comment"># C0 control codes</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line">       <tt class="py-number">0x7F</tt> <tt class="py-op">&lt;=</tt> <tt class="py-name">ord</tt><tt class="py-op">(</tt><tt class="py-name">char</tt><tt class="py-op">)</tt> <tt class="py-op">&lt;=</tt> <tt class="py-number">0x9F</tt><tt class="py-op">)</tt><tt class="py-op">:</tt>  <tt class="py-comment"># Del and C1 control codes</tt> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">True</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line">     </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line">         </tt>
<a name="get_hex_for_char"></a><div id="get_hex_for_char-def"><a name="L35"></a><tt class="py-lineno"> 35</tt> <a class="py-toggle" href="#" id="get_hex_for_char-toggle" onclick="return toggle('get_hex_for_char');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.codec-module.html#get_hex_for_char">get_hex_for_char</a><tt class="py-op">(</tt><tt class="py-param">char</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="get_hex_for_char-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="get_hex_for_char-expanded"><a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-docstring">    Returns the hex equivalent of the given character in the form 3C</tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line">    <tt class="py-keyword">return</tt> <tt class="py-name">hex</tt><tt class="py-op">(</tt><tt class="py-name">ord</tt><tt class="py-op">(</tt><tt class="py-name">char</tt><tt class="py-op">)</tt><tt class="py-op">)</tt><tt class="py-op">[</tt><tt class="py-number">2</tt><tt class="py-op">:</tt><tt class="py-op">]</tt> </tt>
</div><a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"> </tt>
<a name="Codec"></a><div id="Codec-def"><a name="L41"></a><tt class="py-lineno"> 41</tt> <a class="py-toggle" href="#" id="Codec-toggle" onclick="return toggle('Codec');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="esapi.codecs.codec.Codec-class.html">Codec</a><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Codec-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Codec-expanded"><a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line">    <tt class="py-docstring">"""</tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-docstring">    The Codec interface defines a set of methods for encoding and decoding </tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-docstring">    application level encoding schemes, such as HTML entity encoding and </tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"><tt class="py-docstring">    percent encoding (aka URL encoding). Codecs are used in output encoding</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-docstring">    and canonicalization.  The design of these codecs allows for </tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring">    character-by-character decoding, which is necessary to detect </tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-docstring">    double-encoding and the use of multiple encoding schemes, both of which are</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-docstring">    techniques used by attackers to bypass validation and bury encoded attacks</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring">    in data.</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">    @author: Craig Younkins (craig.younkins@owasp.org)</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">    @see: L{esapi.encoder}</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">    """</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line">     </tt>
<a name="Codec.__init__"></a><div id="Codec.__init__-def"><a name="L56"></a><tt class="py-lineno"> 56</tt> <a class="py-toggle" href="#" id="Codec.__init__-toggle" onclick="return toggle('Codec.__init__');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.codec.Codec-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Codec.__init__-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Codec.__init__-expanded"><a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line">        <tt class="py-keyword">pass</tt> </tt>
</div><a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line">            </tt>
<a name="Codec.encode"></a><div id="Codec.encode-def"><a name="L59"></a><tt class="py-lineno"> 59</tt> <a class="py-toggle" href="#" id="Codec.encode-toggle" onclick="return toggle('Codec.encode');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.codec.Codec-class.html#encode">encode</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">immune</tt><tt class="py-op">,</tt> <tt class="py-param">raw</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Codec.encode-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Codec.encode-expanded"><a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring">        Encode a String so that it can be safely used in a specific context.</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring">        @param immune: @param raw</tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"><tt class="py-docstring">                the String to encode</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"><tt class="py-docstring">        @return: the encoded String</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt>     </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line">        <tt class="py-name">ret</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line">        <tt class="py-keyword">try</tt><tt class="py-op">:</tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line">            <tt class="py-keyword">for</tt> <tt class="py-name">char</tt> <tt class="py-keyword">in</tt> <tt class="py-name">raw</tt><tt class="py-op">:</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line">                <tt class="py-name">ret</tt> <tt class="py-op">+=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-4" class="py-name" targets="Method esapi.codecs.codec.Codec.encode_character()=esapi.codecs.codec.Codec-class.html#encode_character,Method esapi.codecs.css.CSSCodec.encode_character()=esapi.codecs.css.CSSCodec-class.html#encode_character,Method esapi.codecs.html_entity.HTMLEntityCodec.encode_character()=esapi.codecs.html_entity.HTMLEntityCodec-class.html#encode_character,Method esapi.codecs.javascript.JavascriptCodec.encode_character()=esapi.codecs.javascript.JavascriptCodec-class.html#encode_character,Method esapi.codecs.ldap.LDAPCodec.encode_character()=esapi.codecs.ldap.LDAPCodec-class.html#encode_character,Method esapi.codecs.ldap_dn.LDAPDNCodec.encode_character()=esapi.codecs.ldap_dn.LDAPDNCodec-class.html#encode_character,Method esapi.codecs.mysql.MySQLCodec.encode_character()=esapi.codecs.mysql.MySQLCodec-class.html#encode_character,Method esapi.codecs.oracle.OracleCodec.encode_character()=esapi.codecs.oracle.OracleCodec-class.html#encode_character,Method esapi.codecs.percent.PercentCodec.encode_character()=esapi.codecs.percent.PercentCodec-class.html#encode_character,Method esapi.codecs.unix.UnixCodec.encode_character()=esapi.codecs.unix.UnixCodec-class.html#encode_character,Method esapi.codecs.vbscript.VBScriptCodec.encode_character()=esapi.codecs.vbscript.VBScriptCodec-class.html#encode_character,Method esapi.codecs.windows.WindowsCodec.encode_character()=esapi.codecs.windows.WindowsCodec-class.html#encode_character"><a title="esapi.codecs.codec.Codec.encode_character
esapi.codecs.css.CSSCodec.encode_character
esapi.codecs.html_entity.HTMLEntityCodec.encode_character
esapi.codecs.javascript.JavascriptCodec.encode_character
esapi.codecs.ldap.LDAPCodec.encode_character
esapi.codecs.ldap_dn.LDAPDNCodec.encode_character
esapi.codecs.mysql.MySQLCodec.encode_character
esapi.codecs.oracle.OracleCodec.encode_character
esapi.codecs.percent.PercentCodec.encode_character
esapi.codecs.unix.UnixCodec.encode_character
esapi.codecs.vbscript.VBScriptCodec.encode_character
esapi.codecs.windows.WindowsCodec.encode_character" class="py-name" href="#" onclick="return doclink('link-4', 'encode_character', 'link-4');">encode_character</a></tt><tt class="py-op">(</tt><tt class="py-name">immune</tt><tt class="py-op">,</tt> <tt class="py-name">char</tt><tt class="py-op">)</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">ret</tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line">        <tt class="py-keyword">except</tt> <tt class="py-name">TypeError</tt><tt class="py-op">:</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line">            <tt class="py-keyword">return</tt> <tt class="py-name">None</tt> </tt>
</div><a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line">         </tt>
<a name="Codec.encode_character"></a><div id="Codec.encode_character-def"><a name="L75"></a><tt class="py-lineno"> 75</tt> <a class="py-toggle" href="#" id="Codec.encode_character-toggle" onclick="return toggle('Codec.encode_character');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.codec.Codec-class.html#encode_character">encode_character</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">immune</tt><tt class="py-op">,</tt> <tt class="py-param">char</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Codec.encode_character-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Codec.encode_character-expanded"><a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line"><tt class="py-docstring">        Default implementation that should be overridden in specific codecs.</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"><tt class="py-docstring">        @param immune: characters immune to encoding</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-docstring">        @param char: the character to encode</tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line"><tt class="py-docstring">        @return: the encoded Character</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line">         </tt>
<a name="Codec.decode"></a><div id="Codec.decode-def"><a name="L85"></a><tt class="py-lineno"> 85</tt> <a class="py-toggle" href="#" id="Codec.decode-toggle" onclick="return toggle('Codec.decode');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.codec.Codec-class.html#decode">decode</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">encoded</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Codec.decode-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Codec.decode-expanded"><a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line"><tt class="py-docstring">        Decode a String that was encoded using the encode method in this Class</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line"><tt class="py-docstring">        @param encoded: the string to decode</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line"><tt class="py-docstring">        @return: the decoded string</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line">        <tt class="py-name">buf</tt> <tt class="py-op">=</tt> <tt class="py-string">''</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line">        <tt class="py-name">pbs</tt> <tt class="py-op">=</tt> <tt id="link-5" class="py-name"><a title="esapi.codecs.push_back_string.PushbackString" class="py-name" href="#" onclick="return doclink('link-5', 'PushbackString', 'link-3');">PushbackString</a></tt><tt class="py-op">(</tt><tt class="py-name">encoded</tt><tt class="py-op">)</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line">        <tt class="py-keyword">while</tt> <tt class="py-name">pbs</tt><tt class="py-op">.</tt><tt id="link-6" class="py-name" targets="Method esapi.codecs.push_back_string.PushbackString.has_next()=esapi.codecs.push_back_string.PushbackString-class.html#has_next"><a title="esapi.codecs.push_back_string.PushbackString.has_next" class="py-name" href="#" onclick="return doclink('link-6', 'has_next', 'link-6');">has_next</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line">            <tt class="py-name">char</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method esapi.codecs.codec.Codec.decode_character()=esapi.codecs.codec.Codec-class.html#decode_character,Method esapi.codecs.css.CSSCodec.decode_character()=esapi.codecs.css.CSSCodec-class.html#decode_character,Method esapi.codecs.html_entity.HTMLEntityCodec.decode_character()=esapi.codecs.html_entity.HTMLEntityCodec-class.html#decode_character,Method esapi.codecs.javascript.JavascriptCodec.decode_character()=esapi.codecs.javascript.JavascriptCodec-class.html#decode_character,Method esapi.codecs.ldap.LDAPCodec.decode_character()=esapi.codecs.ldap.LDAPCodec-class.html#decode_character,Method esapi.codecs.ldap_dn.LDAPDNCodec.decode_character()=esapi.codecs.ldap_dn.LDAPDNCodec-class.html#decode_character,Method esapi.codecs.mysql.MySQLCodec.decode_character()=esapi.codecs.mysql.MySQLCodec-class.html#decode_character,Method esapi.codecs.oracle.OracleCodec.decode_character()=esapi.codecs.oracle.OracleCodec-class.html#decode_character,Method esapi.codecs.percent.PercentCodec.decode_character()=esapi.codecs.percent.PercentCodec-class.html#decode_character,Method esapi.codecs.unix.UnixCodec.decode_character()=esapi.codecs.unix.UnixCodec-class.html#decode_character,Method esapi.codecs.vbscript.VBScriptCodec.decode_character()=esapi.codecs.vbscript.VBScriptCodec-class.html#decode_character,Method esapi.codecs.windows.WindowsCodec.decode_character()=esapi.codecs.windows.WindowsCodec-class.html#decode_character"><a title="esapi.codecs.codec.Codec.decode_character
esapi.codecs.css.CSSCodec.decode_character
esapi.codecs.html_entity.HTMLEntityCodec.decode_character
esapi.codecs.javascript.JavascriptCodec.decode_character
esapi.codecs.ldap.LDAPCodec.decode_character
esapi.codecs.ldap_dn.LDAPDNCodec.decode_character
esapi.codecs.mysql.MySQLCodec.decode_character
esapi.codecs.oracle.OracleCodec.decode_character
esapi.codecs.percent.PercentCodec.decode_character
esapi.codecs.unix.UnixCodec.decode_character
esapi.codecs.vbscript.VBScriptCodec.decode_character
esapi.codecs.windows.WindowsCodec.decode_character" class="py-name" href="#" onclick="return doclink('link-7', 'decode_character', 'link-7');">decode_character</a></tt><tt class="py-op">(</tt><tt class="py-name">pbs</tt><tt class="py-op">)</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">char</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line">                <tt class="py-name">buf</tt> <tt class="py-op">+=</tt> <tt class="py-name">char</tt> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line">                <tt class="py-name">buf</tt> <tt class="py-op">+=</tt> <tt class="py-name">pbs</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Method esapi.codecs.push_back_string.PushbackString.next()=esapi.codecs.push_back_string.PushbackString-class.html#next"><a title="esapi.codecs.push_back_string.PushbackString.next" class="py-name" href="#" onclick="return doclink('link-8', 'next', 'link-8');">next</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line">        <tt class="py-keyword">return</tt> <tt class="py-name">buf</tt> </tt>
</div><a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line">         </tt>
<a name="Codec.decode_character"></a><div id="Codec.decode_character-def"><a name="L102"></a><tt class="py-lineno">102</tt> <a class="py-toggle" href="#" id="Codec.decode_character-toggle" onclick="return toggle('Codec.decode_character');">-</a><tt class="py-line">    <tt class="py-keyword">def</tt> <a class="py-def-name" href="esapi.codecs.codec.Codec-class.html#decode_character">decode_character</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">pbs</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Codec.decode_character-collapsed" style="display:none;" pad="+++" indent="++++++++"></div><div id="Codec.decode_character-expanded"><a name="L103"></a><tt class="py-lineno">103</tt>  <tt class="py-line">        <tt class="py-docstring">"""</tt> </tt>
<a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line"><tt class="py-docstring">        Returns the decoded version of the next character from the input </tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"><tt class="py-docstring">        string and advances the current character in the PushbackString.  </tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line"><tt class="py-docstring">        If the current character is not encoded, this method MUST reset the </tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line"><tt class="py-docstring">        PushbackString.</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line"><tt class="py-docstring">        @param pbs: the PushBackString to decode a character from</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line"><tt class="py-docstring">        @return: the decoded Character</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"><tt class="py-docstring">        """</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line">        <tt class="py-keyword">raise</tt> <tt class="py-name">NotImplementedError</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="esapi-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Sun Nov  8 16:04:24 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
